/**
 * Software License, Version 1.0
 * 
 * Copyright 2003 The Trustees of Indiana University.  All rights reserved.
 * 
 *
 *Redistribution and use in source and binary forms, with or without 
 *modification, are permitted provided that the following conditions are met:
 *
 *1) All redistributions of source code must retain the above copyright notice,
 * the list of authors in the original source code, this list of conditions and
 * the disclaimer listed in this license;
 *2) All redistributions in binary form must reproduce the above copyright 
 * notice, this list of conditions and the disclaimer listed in this license in
 * the documentation and/or other materials provided with the distribution;
 *3) Any documentation included with all redistributions must include the 
 * following acknowledgement:
 *
 *"This product includes software developed by the Community Grids Lab. For 
 * further information contact the Community Grids Lab at 
 * http://communitygrids.iu.edu/."
 *
 * Alternatively, this acknowledgement may appear in the software itself, and 
 * wherever such third-party acknowledgments normally appear.
 * 
 *4) The name Indiana University or Community Grids Lab or NaradaBrokering, 
 * shall not be used to endorse or promote products derived from this software 
 * without prior written permission from Indiana University.  For written 
 * permission, please contact the Advanced Research and Technology Institute 
 * ("ARTI") at 351 West 10th Street, Indianapolis, Indiana 46202.
 *5) Products derived from this software may not be called NaradaBrokering, 
 * nor may Indiana University or Community Grids Lab or NaradaBrokering appear
 * in their name, without prior written permission of ARTI.
 * 
 *
 * Indiana University provides no reassurances that the source code provided 
 * does not infringe the patent or any other intellectual property rights of 
 * any other entity.  Indiana University disclaims any liability to any 
 * recipient for claims brought by any other entity based on infringement of 
 * intellectual property rights or otherwise.  
 *
 *LICENSEE UNDERSTANDS THAT SOFTWARE IS PROVIDED "AS IS" FOR WHICH NO 
 *WARRANTIES AS TO CAPABILITIES OR ACCURACY ARE MADE. INDIANA UNIVERSITY GIVES
 *NO WARRANTIES AND MAKES NO REPRESENTATION THAT SOFTWARE IS FREE OF 
 *INFRINGEMENT OF THIRD PARTY PATENT, COPYRIGHT, OR OTHER PROPRIETARY RIGHTS. 
 *INDIANA UNIVERSITY MAKES NO WARRANTIES THAT SOFTWARE IS FREE FROM "BUGS", 
 *"VIRUSES", "TROJAN HORSES", "TRAP DOORS", "WORMS", OR OTHER HARMFUL CODE.  
 *LICENSEE ASSUMES THE ENTIRE RISK AS TO THE PERFORMANCE OF SOFTWARE AND/OR 
 *ASSOCIATED MATERIALS, AND TO THE PERFORMANCE AND VALIDITY OF INFORMATION 
 *GENERATED USING SOFTWARE.
 */
package cgl.narada.wsinfra.wsrm.storage;

import java.io.File;

import cgl.narada.wsinfra.wsrm.storage.impl.WsrmStorageServiceImpl;
/** The WsrmStorageService provides accesses to 3 interfaces which cover
    the gamut of storage operations specific to the WSRM protocol.

    @author Shrideep Pallickara, Sangmi Lee and Beytullah Yildiz
    $Date: 2005/07/29 22:41:31 $
    $Revision: 1.5 $
*/

public abstract class WsrmStorageService {
  private static WsrmStorageService wsrmStorageService = null;
  private static String configFilename = null;
  private static String defaultConfig = "./config/ServiceConfiguration.txt";
  private static String moduleName = "WsrmStorageService: ";

  public static WsrmStorageService getInstance(String configFileLocation)
    throws WsrmStorageException {


    /** Check to see if a valid file location has been specified. If it is
	either NULL or "", revert to the default file location */
    if (configFileLocation == null) {
      configFileLocation = defaultConfig;
    }

    configFileLocation.trim(); //eliminate white spaces
    if (configFileLocation == "") {
      configFileLocation = defaultConfig;
    }


    File configFile = new File(configFileLocation);
    String absolutePath = null;
    
    if (!configFile.exists()) {
      String errorReport = moduleName + 
	"No file corresponding to Config location [" + configFileLocation + 
	"] exists. Check the supplied info.";
      throw new WsrmStorageException(errorReport);
    }

    try {
      absolutePath = configFile.getAbsolutePath();
      configFileLocation = absolutePath;
    } catch (SecurityException secEx) {
      System.out.println(moduleName + "Problems creating AbsolutePath for [" +
			 configFileLocation + "], will do without it. ");
      absolutePath = configFileLocation;
    }


    /** Since no instance currently exists try to create one using the
	specified file location */
    if (wsrmStorageService == null) {
      configFilename = absolutePath;
      wsrmStorageService = new WsrmStorageServiceImpl(configFilename);
      return wsrmStorageService;
    }


    /** Make sure that the request for the instance always comes in with
	the same config file location, if not throw an exception since the
	user is trying to access a different database other than the singleton
	instance that has been created. */
    if (!configFileLocation.equals(configFilename) ) {
      throw
	new WsrmStorageException("The WsrmStorageService " +
				 "has already been initialized using file [" +
				 configFilename + "], you have specified a " +
				 " different file [" + configFileLocation
				 + "]");
    }

    return wsrmStorageService;
  }

  /** This method is used to initialize the storage interfaces and tables
      when the service starts up for the first time or after a scheduled
      downtime or is recovering from an unforeseen failure. This method
      checks for consistencies across the storage and proceeds to initialize
      the ProtocolStorageOperations, SequenceInfoOperations and
      AuditStorageOperations.  This method throws an exception if there are
      storage related problems. */
  public abstract void initialize() throws WsrmStorageException;


  /** Retrieves the reference to the WsrmProtocolStorageOperations. This method
      throws an exception if there were problems during the initialization of
      the StorageService due to inconsistencies or other storage related
      problems. */
  public  abstract WsrmProtocolStorageOperations
  getWsrmProtocolStorageOperations()
    throws WsrmStorageException;



  /** Retrieves the reference to  WsrmSequenceInfoStorageOperations. This
      method throws an exception if there were problems during the
      initialization of the StorageService due to inconsistencies or other
      storage related problems. */
  public  abstract WsrmSequenceInfoStorageOperations
  getWsrmSequenceInfoStorageOperations() throws WsrmStorageException;



  /** Retrieves the reference to  WsrmAuditStorageOperations. This method
      throws an exception if there were problems during the initialization of
      the StorageService due to inconsistencies or other storage related
      problems. */
  public  abstract WsrmAuditStorageOperations getWsrmAuditStorageOperations()
    throws WsrmStorageException;


  /** Retrieves the reference to WsrmPolicyStorageOperations. This interface
      is especially useful in determing the WsrmSequencePolicies associated
      with sequences, whose sequence-identifier values have a partial match
      (i.e. the prefix is the same as the one previously stored here). */
  public abstract WsrmPolicyStorageOperations
  getWsrmPolicyStorageOperations() throws WsrmStorageException;


}
